chore(proto): gate AIP lint in CI and fix buf.yaml accuracy - #431
Open
richardthe3rd wants to merge 1 commit into
Open
chore(proto): gate AIP lint in CI and fix buf.yaml accuracy#431richardthe3rd wants to merge 1 commit into
richardthe3rd wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
🚀 Cloudflare Pages PreviewYour preview deployment is ready! Preview URL: https://claude-api-definitions-revie.staging-cambeerfestival.pages.dev This preview will be automatically updated when you push new commits to this PR. |
Add the AIP design linter (api-linter) to the CI proto job with --set-exit-status so design-level regressions buf's STANDARD ruleset doesn't cover actually gate merges; mirror the flag in the proto:api-lint mise task. Pin buf (1.70.0) and api-linter (2.3.1) in dev and CI so local and CI results agree. Fix the stale buf.yaml lint comment (Delete returns the resource tombstone per AIP-164, not google.protobuf.Empty) and drop the now-dead empty.proto breaking-ignore entry. Correct the promotion-path comment to reference the real buf category WIRE_JSON (WIRE_JSON_COMPATIBLE is not a valid category); the WIRE + ignore_unstable_packages alpha strategy is left unchanged.
richardthe3rd
force-pushed
the
claude/api-definitions-review-y8gtuc
branch
from
June 15, 2026 08:09
0787340 to
065089e
Compare
richardthe3rd
changed the title
Contributor
🚀 Cloudflare Pages PreviewYour preview deployment is ready! Preview URL: https://claude-api-definitions-revie.staging-cambeerfestival.pages.dev This preview will be automatically updated when you push new commits to this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Tooling fixes for the proto API contract, rebased onto current
main(after #433 added the festival catalogue API and renamed the proto treemyfestival/→festival/).AIP linter now gates CI (
.github/workflows/ci.yml,mise.dev.toml)Added an
api-linterstep to the CIprotojob with--set-exit-statusso design-level regressions — the rules buf's STANDARD ruleset doesn't cover — actually fail the build. Added the same flag to theproto:api-lintmise task (it previously printed problems but exited 0, so it wasn't really a gate). Lints all 7festival/v1alpha/protos. Pinnedbuf(1.70.0) andapi-linter(2.3.1) in both dev and CI so local and CI results agree.buf.yamlaccuracy fixesDeletereturns theDrinkEntrytombstone (soft delete, AIP-164), notgoogle.protobuf.Empty.ignore: google/protobuf/empty.protobreaking entry (nothing importsempty.proto).WIRE_JSON—WIRE_JSON_COMPATIBLEis not a valid category, so following the documented v1 plan as written would fail.Note on breaking strategy
This PR originally proposed switching active breaking detection to
WIRE_JSONnow. After #433 adoptedignore_unstable_packages: true(alpha packages exempt from breaking checks, JSON-level checks deferred to v1), that strategy is left unchanged — it's the right call for a churning alpha API (it's what enabled themyfestival→festivalrename). The only breaking-config change here is fixing the invalid category name in the forward-looking comment.Verification
Run locally against the real binaries (caught two bugs before they reached CI:
WIRE_JSON_COMPATIBLEisn't a valid buf category — it'sWIRE_JSON; andgo installof api-linter v2 needs the/v2module path):buf lint→ exit 0buf format --diff --exit-code→ exit 0buf breaking(config valid,WIRE+ignore_unstable_packages) → exit 0api-linter --set-exit-status→problems: []for all 7 protos, exit 0https://claude.ai/code/session_01MPdgVxaNBHJdL8hnyFGYpC